Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for 4-digit 7-segment display #282

Closed
wants to merge 24 commits into from

Conversation

leandrumartin
Copy link
Collaborator

Resolves #277.

The documentation for the 4-digit 7-segment display component was added in fourDigitSevenSegment.adoc along with appropriate diagrams. The documentation describes necssary components, assembly instructions, functionality, how to test it, and troubleshooting.

The functionality description specifies what values are allowed as input to the display. The assembly instructions are partially stubbed out for now.

The changes here also include changes merged from the branch adding the 4-digit 7-segment display, pi4micronaut-44. These changes are to FourDigitSevenSegmentDisplayController.java, application.yml, FourDigitSevenSegmentDisplayHelper.java, and FourDigitSevenSegmentDisplayHelperTest.java.

…ntative implementation of single-digit seven-segment display helper.
…naut-44

# Conflicts:
#	components/src/main/resources/application.yml
…play. Commented out tests. Stubbed out method for displaying numbers, for testing
…ment display requires multiple digital output pins.
@leandrumartin leandrumartin self-assigned this Nov 11, 2024
* Connect a jumper wire from each "digit" pin of the 4-digit 7-segment to one of the resistors.
* Connect the other end of the resistors to the Raspberry Pi's pins:

- Digit 1 to GPIO17 (BCM pin 18)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure that when the new version of the code is submitted that the appropriate wiring configuration changes changes according to it.


[source,yaml]
----
i2c:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure to change your config if that changes based on the new updates to the controller later.


[source,bash]
----
$ curl http://localhost:8080/four-digit-seven-segment/enable
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For ease of use and documentation maybe create a curl for each function reference, such as adding

curl http://localhost:8080/four-digit-segment/clear

to show it without question.

Copy link
Collaborator

@yrlmanoharreddy yrlmanoharreddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your pull request includes helper functionality, controller, and YAML configuration changes that were already pushed in the previous sprint. Since that pull request is still pending, you should push updates into the existing one instead. This current pull request should only contain files modified under the docs section. Please remove all unrelated files to keep the changes focused and maintain a clean commit history

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Documentation for four digit seven segment display
3 participants